# {{cookiecutter.project_name}}


## Описание проекта

{{cookiecutter.description}}


## Структура проекта

```
├── LICENSE            <- Лицензия (опционально)
├── Makefile           <- Makefile с командами типа `make data` or `make train`
├── README.md          <- Верхнеуровневое описание проекта
├── data
│   ├── external       <- Данные, полученные из внешних источников
│   ├── processed      <- Данные для моделирования
│   └── raw            <- Сырые (оригинальные) данные
│
├── docs               <- A default mkdocs project; see mkdocs.org for details
│
├── models             <- Обученные, сериализованные модели
│
├── notebooks          <- Jupyter ноутбуки. Naming convention is a number (for ordering),
│                         the creator's initials, and a short `-` delimited description, e.g.
│                         `1.0-jqp-initial-data-exploration`.
│
├── pyproject.toml     <- Project configuration file with package metadata for {{ cookiecutter.project_name }}
│                         and configuration for tools like black
│
├── references         <- Описание данных, мануалы и другие материалы
│
├── reports            <- Сгенерированные отчеты в определенных форматах
│   └── figures        <- Сгенерированные графики, изображения, которые используются в отчете
│
├── requirements-research.txt        <- Файл с версиями библиотеки для воспроизводимости результатов. Создается с помощью
│                                       команды `pip freeze > requirements.txt`
│
├── requirements-dev.txt             <- Файл с версиями библиотеки для разработки.
│
├── .pre-commit-config.yaml          <- Конфигурационный файл для pre-commit
│
└── {{ cookiecutter.project_name }}   <- Исходный код проекта
    │
    ├── __init__.py    <- Инициализация {{ cookiecutter.project_name }} модуля
    │
    ├── data           <- Скрипты для загрузки или генерации данных
    │   └── make_dataset.py
    │
    ├── features       <- Скрипты для трансформации сырых данных в данные для обучения модели
    │   └── build_features.py
    │
    ├── models         <- Скрипты для обучения и использования модели
    │   │
    │   ├── predict_model.py
    │   └── train_model.py
    │
    └── visualization  <- Скрипты генерации визуализации данных
        └── visualize.py
```

## Установка


## Использование